PBGetVolMountInfo

PBGetVolMountInfo
Header:	Files.h		Carbon status:	Supported

Retrieves a record containing all the information needed to mount the volume, except for passwords.

OSErr PBGetVolMountInfo (
    ParmBlkPtr paramBlock
);

Parameter descriptions

paramBlock: A pointer to a basic File Manager parameter block.

function result: A result code.

DISCUSSION

The relevant fields of the parameter block are:

ioCompletion

On input, a pointer to a completion function.
ioResult

On output, the result code of the function.
ioVRefNum

On input, a volume specification.
ioBuffer

On input, a pointer to a buffer to hold the mounting information. On return, the mounting information for the specified volume. You can later pass this structure to the PBVolumeMount function to mount the volume.

The mounting information for an AppleShare volume is stored as an AFP mounting record. The length of the buffer is specified by the value pointed to by the ioBuffer field in a previous call to PBGetVolMountInfoSize.

This function allows your application to record the mounting information for a volume and then to mount the volume later. This programmatic mounting function stores the mounting information in a structure called the AFPVolMountInfo structure. The programmatic mounting functions use the ioParam variant of the ParamBlockRec structure.

The PBGetVolMountInfo function does not return the user password or volume password in the AFPVolMountInfo structure. Your application should solicit these passwords from the user and fill in the structure before attempting to mount the remote volume.

In general, it is easier to mount remote volumes by creating and then resolving alias records that describe those volumes. The Alias Manager displays the standard user interface for user authentication when resolving alias records for remote volumes. As a result, this function is primarily of interest for applications that need to mount remote volumes with no user interface or with some custom user interface.

This function executes synchronously. You should not call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.